Skip to content

Mitigate crashes during scala-library-bootstrapped/doc #24510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 4 commits into from
Closed

Mitigate crashes during scala-library-bootstrapped/doc #24510

wants to merge 4 commits into from
+7 −13

Conversation

@WojciechMazur
Copy link
Contributor

@WojciechMazur WojciechMazur commented Nov 23, 2025 •
edited
Loading

This changes can be used as best effort mitigation of underlying issues allowing for produce javadoc for scala-library required when publishing artifacts to Sonatype, however I don't believe it's a final solution of underlying issues. Some types seem not be rendered correctly, see details below

image

edit

Actually it seems to not be related to this change, similar problems are visible when using scaladoc/generateScalaDocumentation (the non-bootstrapped variant)

image

Created a dedicated issue #24511

Depends on #24433 changes, rebase required before merge

During scaladoc generation with --from-tasty, the compiler reads TASTY files in Mode.ReadPositions. Symbols may be incomplete, phases may not be set up, and some validation checks run that shouldn't during TASTY reading. This caused crashes and false errors.

Error 1: Assertion failure in base class computation

java.lang.AssertionError: assertion failed: class Tuple2 has non-class parent: TypeRef(TermRef(TermRef(NoPrefix,object _root_),object scala),Serializable)
    at dotty.tools.dotc.core.SymDenotations$ClassDenotation.traverse$1(SymDenotations.scala:2056)
    at dotty.tools.dotc.core.SymDenotations$ClassDenotation.computeBaseData(SymDenotations.scala:2061)
    ...
    at dotty.tools.dotc.fromtasty.ReadTasty.addTasty(ReadTasty.scala:33)

Error 2: Assertion failure in TreeInfo.sliceTopLevel

java.lang.AssertionError: assertion failed
    at dotty.tools.dotc.ast.TypedTreeInfo.sliceTopLevel(TreeInfo.scala:1015)
    at dotty.tools.dotc.transform.SetRootTree$$anon$1.traverse(SetRootTree.scala:33)
    ...
    at dotty.tools.dotc.typer.Namer.lateTypeCheck$1(Namer.scala:772)

Error 3: Assertion failure in implicit search

java.lang.AssertionError: assertion failed: missing implicit parameter of type G[From] after typer at phase <no phase>
    at dotty.tools.dotc.typer.Implicits.inferImplicit(Implicits.scala:1103)
    ...
    at dotty.tools.dotc.typer.Namer.lateTypeCheck$1(Namer.scala:770)

Error 4-6: False validation errors (only during --from-tasty)

  • Capture checking: scala.caps.cap.type cannot be tracked since it is not a parameter or local value
  • Naming conflicts: class consume cannot have the same name as class consume in object internal
  • TargetName clashes: @targetName annotation "" clashes with other definition in same scope

@WojciechMazur
Setup doc / scalaInstance instance to be used when building docs.
4ebccb0 
Enable `packageDoc / publishArtifact` for bootstrapped projects - javadoc is required by Sonatype validation
@WojciechMazur
Enable scala-library-bootstrapped docs generation again
26440da
@WojciechMazur
Adjust assertions and errors to be more relaxed under --from-tasty co…
ae78649 
…mpilation (Mode.ReadPositions)
@WojciechMazur WojciechMazur mentioned this pull request Nov 23, 2025
Open
@Gedochao
Copy link
Contributor

Gedochao commented Nov 27, 2025

Just to keep things linked, this is an attempt at working around #24434 (correct me if I'm wrong)

@WojciechMazur
Copy link
Contributor Author

WojciechMazur commented Nov 27, 2025

Just to keep things linked, this is an attempt at working around #24434 (correct me if I'm wrong)

Yes, however it was mostly based on LLM outputs, so I would not trust this change at any level (regardless if it passes tests or not)

@WojciechMazur WojciechMazur mentioned this pull request Nov 27, 2025
Closed
@hamzaremmal hamzaremmal mentioned this pull request Nov 28, 2025
Merged
@WojciechMazur WojciechMazur deleted the fix/scala-library-doc branch November 28, 2025 11:43
hamzaremmal added a commit that referenced this pull request Nov 28, 2025
@hamzaremmal
fix: allow to generate the documentation of the stdlib (#24574)
3828975 
Based on @bracevac remarks here
#24434 (comment)

We do not need to add `-sourcepath` when generating the scaladoc since
compiling with `-from-tasty` (what scaladoc does) will put the TASTy in
the classpath. This means that the compiler will be happy and will find
the symbols.

Closes #24434
Supersedes #24569, #24510.

Thanks Oliver for taking the time to analyze the issue in depth.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@WojciechMazur @Gedochao